[ES|QL] Document return value for locate in case substring is not found #112202
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ioanatia
added
>docs
|
Documentation preview: |
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/es-analytical-engine (Team:Analytics) |
nik9000
approved these changes
Aug 26, 2024
costin
requested changes
Aug 26, 2024
costin
requested changes
Aug 26, 2024
costin
approved these changes
Aug 27, 2024
| examples = @Example(file = "string", tag = "locate") | ||
| ) | ||
| @FunctionInfo(returnType = "integer", description = """ | ||
| Returns an integer that indicates the position of a keyword substring within another string. |
There was a problem hiding this comment.
Returns an integer (starting from 1) that indicates the position of a keyword substring within another string.
Returns 0 if the substring is not found.
There was a problem hiding this comment.
Many developers are not used with string positions starting from 1. This is why I kind of like to have that as a separate note. If you feel very strongly about I can change this again, but for now I will merge the PR as it is.
💔 Backport failed
You can use sqren/backport to manually backport by running |
cbuescher
pushed a commit
to cbuescher/elasticsearch
that referenced
this pull request
Sep 4, 2024
…nd (elastic#112202) * Document return value for locate in case substring is not found * Add note that string positions start from 1
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I wanted to use the
LOCATEfunction for a test and noticed that we don't document the return value in case the substring is missing.